/*
 * This file is part of WebGoat, an Open Web Application Security Project utility. For details,
 * please see http://www.owasp.org/
 * <p>
 * Copyright (c) 2002 - 2017 Bruce Mayhew
 * <p>
 * This program is free software; you can redistribute it and/or modify it under the terms of the
 * GNU General Public License as published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 * <p>
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
 * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 * <p>
 * You should have received a copy of the GNU General Public License along with this program; if
 * not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 * 02111-1307, USA.
 * <p>
 * Getting Source ==============
 * <p>
 * Source for this application is maintained at https://github.com/WebGoat/WebGoat, a repository for free software
 * projects.
 * <p>
 */

package org.owasp.webgoat.container.assignments;

import lombok.Getter;
import org.owasp.webgoat.container.i18n.PluginMessages;
import org.owasp.webgoat.container.lessons.Initializeable;
import org.owasp.webgoat.container.session.UserSessionData;
import org.owasp.webgoat.container.session.WebSession;
import org.owasp.webgoat.container.users.WebGoatUser;
import org.springframework.beans.factory.annotation.Autowired;

public abstract class AssignmentEndpoint implements Initializeable {

    @Autowired
    private WebSession webSession;
    @Autowired
    private UserSessionData userSessionData;
    @Getter
    @Autowired
    private PluginMessages messages;

    protected WebSession getWebSession() {
        return webSession;
    }

    protected UserSessionData getUserSessionData() {
        return userSessionData;
    }

    /**
     * Convenience method for create a successful result:
     * <p>
     * - Assignment is set to solved
     * - Feedback message is set to 'assignment.solved'
     * <p>
     * Of course you can overwrite these values in a specific lesson
     *
     * @return a builder for creating a result from a lesson
     * @param assignment
     */
    protected AttackResult.AttackResultBuilder success(AssignmentEndpoint assignment) {
        return AttackResult.builder(messages).lessonCompleted(true).attemptWasMade().feedback("assignment.solved").assignment(assignment);
    }

    /**
     * Convenience method for create a failed result:
     * <p>
     * - Assignment is set to not solved
     * - Feedback message is set to 'assignment.not.solved'
     * <p>
     * Of course you can overwrite these values in a specific lesson
     *
     * @return a builder for creating a result from a lesson
     * @param assignment
     */
    protected AttackResult.AttackResultBuilder failed(AssignmentEndpoint assignment) {
        return AttackResult.builder(messages).lessonCompleted(false).attemptWasMade().feedback("assignment.not.solved").assignment(assignment);
    }

    protected AttackResult.AttackResultBuilder informationMessage(AssignmentEndpoint assignment) {
        return AttackResult.builder(messages).lessonCompleted(false).assignment(assignment);
    }

    @Override
    public void initialize(WebGoatUser user) {
    }
}
